home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chbgvd.z / chbgvd
Encoding:
Text File  |  2002-10-03  |  8.9 KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHBGVD - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a complex generalized Hermitian-definite banded eigenproblem, of the form
  11.      A*x=(lambda)*B*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CHBGVD( JOBZ, UPLO, N, KA, KB, AB, LDAB, BB, LDBB, W, Z, LDZ,
  15.                         WORK, LWORK, RWORK, LRWORK, IWORK, LIWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ, UPLO
  18.  
  19.          INTEGER        INFO, KA, KB, LDAB, LDBB, LDZ, LIWORK, LRWORK, LWORK,
  20.                         N
  21.  
  22.          INTEGER        IWORK( * )
  23.  
  24.          REAL           RWORK( * ), W( * )
  25.  
  26.          COMPLEX        AB( LDAB, * ), BB( LDBB, * ), WORK( * ), Z( LDZ, * )
  27.  
  28. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  29.      These routines are part of the SCSL Scientific Library and can be loaded
  30.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  31.      directs the linker to use the multi-processor version of the library.
  32.  
  33.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  34.      4 bytes (32 bits). Another version of SCSL is available in which integers
  35.      are 8 bytes (64 bits).  This version allows the user access to larger
  36.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  37.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  38.      only one of the two versions; 4-byte integer and 8-byte integer library
  39.      calls cannot be mixed.
  40.  
  41. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  42.      CHBGVD computes all the eigenvalues, and optionally, the eigenvectors of
  43.      a complex generalized Hermitian-definite banded eigenproblem, of the form
  44.      A*x=(lambda)*B*x. Here A and B are assumed to be Hermitian and banded,
  45.      and B is also positive definite.  If eigenvectors are desired, it uses a
  46.      divide and conquer algorithm.
  47.  
  48.      The divide and conquer algorithm makes very mild assumptions about
  49.      floating point arithmetic. It will work on machines with a guard digit in
  50.      add/subtract, or on those binary machines without guard digits which
  51.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  52.      conceivably fail on hexadecimal or decimal machines without guard digits,
  53.      but we know of none.
  54.  
  55.  
  56. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  57.      JOBZ    (input) CHARACTER*1
  58.              = 'N':  Compute eigenvalues only;
  59.              = 'V':  Compute eigenvalues and eigenvectors.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      UPLO    (input) CHARACTER*1
  75.              = 'U':  Upper triangles of A and B are stored;
  76.              = 'L':  Lower triangles of A and B are stored.
  77.  
  78.      N       (input) INTEGER
  79.              The order of the matrices A and B.  N >= 0.
  80.  
  81.      KA      (input) INTEGER
  82.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  83.              the number of subdiagonals if UPLO = 'L'. KA >= 0.
  84.  
  85.      KB      (input) INTEGER
  86.              The number of superdiagonals of the matrix B if UPLO = 'U', or
  87.              the number of subdiagonals if UPLO = 'L'. KB >= 0.
  88.  
  89.      AB      (input/output) COMPLEX array, dimension (LDAB, N)
  90.              On entry, the upper or lower triangle of the Hermitian band
  91.              matrix A, stored in the first ka+1 rows of the array.  The j-th
  92.              column of A is stored in the j-th column of the array AB as
  93.              follows:  if UPLO = 'U', AB(ka+1+i-j,j) = A(i,j) for max(1,j-
  94.              ka)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  95.              j<=i<=min(n,j+ka).
  96.  
  97.              On exit, the contents of AB are destroyed.
  98.  
  99.      LDAB    (input) INTEGER
  100.              The leading dimension of the array AB.  LDAB >= KA+1.
  101.  
  102.      BB      (input/output) COMPLEX array, dimension (LDBB, N)
  103.              On entry, the upper or lower triangle of the Hermitian band
  104.              matrix B, stored in the first kb+1 rows of the array.  The j-th
  105.              column of B is stored in the j-th column of the array BB as
  106.              follows:  if UPLO = 'U', BB(kb+1+i-j,j) = B(i,j) for max(1,j-
  107.              kb)<=i<=j; if UPLO = 'L', BB(1+i-j,j)    = B(i,j) for
  108.              j<=i<=min(n,j+kb).
  109.  
  110.              On exit, the factor S from the split Cholesky factorization B =
  111.              S**H*S, as returned by CPBSTF.
  112.  
  113.      LDBB    (input) INTEGER
  114.              The leading dimension of the array BB.  LDBB >= KB+1.
  115.  
  116.      W       (output) REAL array, dimension (N)
  117.              If INFO = 0, the eigenvalues in ascending order.
  118.  
  119.      Z       (output) COMPLEX array, dimension (LDZ, N)
  120.              If JOBZ = 'V', then if INFO = 0, Z contains the matrix Z of
  121.              eigenvectors, with the i-th column of Z holding the eigenvector
  122.              associated with W(i). The eigenvectors are normalized so that
  123.              Z**H*B*Z = I.  If JOBZ = 'N', then Z is not referenced.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDZ     (input) INTEGER
  141.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  142.              'V', LDZ >= N.
  143.  
  144.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  145.              On exit, if INFO=0, WORK(1) returns the optimal LWORK.
  146.  
  147.      LWORK   (input) INTEGER
  148.              The dimension of the array WORK.  If N <= 1,               LWORK
  149.              >= 1.  If JOBZ = 'N' and N > 1, LWORK >= N.  If JOBZ = 'V' and N
  150.              > 1, LWORK >= 2*N**2.
  151.  
  152.              If LWORK = -1, then a workspace query is assumed; the routine
  153.              only calculates the optimal size of the WORK array, returns this
  154.              value as the first entry of the WORK array, and no error message
  155.              related to LWORK is issued by XERBLA.
  156.  
  157.      RWORK   (workspace/output) REAL array, dimension (LRWORK)
  158.              On exit, if INFO=0, RWORK(1) returns the optimal LRWORK.
  159.  
  160.      LRWORK  (input) INTEGER
  161.              The dimension of array RWORK.  If N <= 1,               LRWORK >=
  162.              1.  If JOBZ = 'N' and N > 1, LRWORK >= N.  If JOBZ = 'V' and N >
  163.              1, LRWORK >= 1 + 5*N + 2*N**2.
  164.  
  165.              If LRWORK = -1, then a workspace query is assumed; the routine
  166.              only calculates the optimal size of the RWORK array, returns this
  167.              value as the first entry of the RWORK array, and no error message
  168.              related to LRWORK is issued by XERBLA.
  169.  
  170.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  171.              On exit, if INFO=0, IWORK(1) returns the optimal LIWORK.
  172.  
  173.      LIWORK  (input) INTEGER
  174.              The dimension of array IWORK.  If JOBZ = 'N' or N <= 1, LIWORK >=
  175.              1.  If JOBZ = 'V' and N > 1, LIWORK >= 3 + 5*N.
  176.  
  177.              If LIWORK = -1, then a workspace query is assumed; the routine
  178.              only calculates the optimal size of the IWORK array, returns this
  179.              value as the first entry of the IWORK array, and no error message
  180.              related to LIWORK is issued by XERBLA.
  181.  
  182.      INFO    (output) INTEGER
  183.              = 0:  successful exit
  184.              < 0:  if INFO = -i, the i-th argument had an illegal value
  185.              > 0:  if INFO = i, and i is:
  186.              <= N:  the algorithm failed to converge:  i off-diagonal elements
  187.              of an intermediate tridiagonal form did not converge to zero; >
  188.              N:   if INFO = N + i, for 1 <= i <= N, then CPBSTF
  189.              returned INFO = i: B is not positive definite.  The factorization
  190.              of B could not be completed and no eigenvalues or eigenvectors
  191.              were computed.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHBBBBGGGGVVVVDDDD((((3333SSSS))))
  203.  
  204.  
  205.  
  206. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  207.      Based on contributions by
  208.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  209.  
  210.  
  211. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  212.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  213.  
  214.      This man page is available only online.
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.